Edit Task: RecurringSTKReportsRepeats
Description
The RecurringSTKReportsRepeats attribute under EditTask defines a number of recurring STK Reports for the given task and defined windows can be duplicated a set amount of times. Any previous Availability STK Report definitions are deleted.
Parameters
| Parameter | Description |
|---|---|
| StartTime | Report Start Time. The format is YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff. |
| StopTime | Report Stop Time. The format is YYYY/MM/DD_HH:MM:SS or YYYY/MM/DD_HH:MM:SS.fff. |
| WindowType | Options are either FixedStart, FixedStop, FixedStartOrStop, Window, ValueRange, ValueReport. |
StartOffset
| For Single Time type reports the parameter should be entered as a number in seconds(millisecond fidelity). This parameter should be ignored if WindowType is 'FixedStop'. Optional parameter if WindowType is set to "Window". |
| Value1 | For Value type reports, this is the first value. |
| MinValue | For Value Range reports, this is the minimum value. |
StopOffset | For Single Time type reports the parameter should be entered as a number in seconds(millisecond fidelity). This parameter should be ignored if WindowType is 'FixedStart'. Optional parameter if WindowType is set to "Window". |
| Value2 | For Value type reports, this is the second value. |
| MaxValue | For Value Range reports, this is the maximum value. |
| Duration | The parameter should be entered as a number representing seconds (millisecond fidelity). If the number is negative, the report will be set to work as if the Next Time Value In Report Option in the STK Time Report Form is checked (True), which means each window will be as long as the time between each report value.
The parameter is ignored if <RepNWindowType> is set to 'Window' or 'ValueRange'. |
| STKObject1 | A string of text in single quotes of the STKObject path, not including the scenario name (ex. 'Satellite/FUSE'). Empty string is not allowed and the parameter is case sensitive. |
| STKObject2 | A string of text in single quotes of the STKObject path, not including the scenario name (ex. 'Satellite/TRACE'). The parameter is case sensitive and an empty string is allowed for reports that only use 1 STK Object. |
| ReportName | A string of text in single quotes of the STK report type. This value must be compatible with the number of defined STK Objects for <RepNSTKObj1> and <RepNSTKObj2>. Empty string is not allowed and the parameter is case sensitive. |
| MaintainTimeOffset | The parameter is either 'TRUE' or 'FALSE'. If 'FALSE', then any report start/stop time offsets from schedule start/stop times are maintained if schedule start/stop times are changed. Empty string is not allowed. |
| PostProcessorPath | The path of a script file that will be run on the STK report. The path should be a string of text in single quotes. Perl, PowerShell, and scripts or programs that may be run as commands from the Windows Command Line are supported. The script should expect one parameter, a path string for an input file (the STK report). The file will be rows of comma-separated values, with the first row giving value names. This parameter may be omitted. |
| WindowRepeats | An integer value that creates duplicate windows based on this value. |
Examples
Set recurring time windows based on the sun report from STK.
PATCH api/task/TaskA
Body:
{
"NonRecurringSTKReports" : {
"StartTime" : "2014/01/01_00:00:00.000",
"StopTime" : "2014/01/03_00:00:00.000",
"WindowType" : "Window",
"StartOffset" : "0",
"StopOffset" : "0",
"STKObject1" : "Satellite/FUSE",
"ReportName" : "Sun",
"MaintainTimeOffset" : "TRUE",
"WindowsRepeats" : "3"
}
}
